eslint-plugin-jest
ESLint plugin for Jest
Installation
$ yarn add --dev eslint eslint-plugin-jest
Note: If you installed ESLint globally then you must also install
eslint-plugin-jest
globally.
Usage
Add jest
to the plugins section of your .eslintrc
configuration file. You
can omit the eslint-plugin-
prefix:
{
"plugins": ["jest"]
}
Then configure the rules you want to use under the rules section.
{
"rules": {
"jest/no-disabled-tests": "warn",
"jest/no-focused-tests": "error",
"jest/no-identical-title": "error",
"jest/prefer-to-have-length": "warn",
"jest/valid-expect": "error"
}
}
You can also whitelist the environment variables provided by Jest by doing:
{
"env": {
"jest/globals": true
}
}
Shareable configurations
Recommended
This plugin exports a recommended configuration that enforces good testing
practices.
To enable this configuration use the extends
property in your .eslintrc
config file:
{
"extends": ["plugin:jest/recommended"]
}
Style
This plugin also exports a configuration named style
, which adds some
stylistic rules, such as prefer-to-be-null
, which enforces usage of toBeNull
over toBe(null)
.
To enable this configuration use the extends
property in your .eslintrc
config file:
{
"extends": ["plugin:jest/style"]
}
See
ESLint documentation
for more information about extending configuration files.
All
If you want to enable all rules instead of only some you can do so by adding the
all
configuration to your .eslintrc
config file:
{
"extends": ["plugin:jest/all"]
}
While the recommended
and style
configurations only change in major versions
the all
configuration may change in any release and is thus unsuited for
installations requiring long-term consistency.
Rules
Credit
Related Projects
eslint-plugin-jest-formatting
This project aims to provide formatting rules (auto-fixable where possible) to
ensure consistency and readability in jest test suites.
https://github.com/dangreenisrael/eslint-plugin-jest-formatting